-
Notifications
You must be signed in to change notification settings - Fork 31
[Doc] Update to DocumenterVitepress.jl v0.2
#467
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
I had a similar issue, don't delete the semi-links just yet. (put them back). My guess is that we should do that after/before doing a new release, still experimenting with it 😄 . |
|
and this one: https://github.com/qutip/QuantumToolbox.jl/tree/gh-pages/.github/workflows you should delete. Otherwise it overwrites your deploys, not good. |
Yes, I just delete it, thank you ! |
Hmm, it is still not rendering correctly @@. Do you have other idea ? |
|
When I add the symbolic links back, it doesn't seem as the normal symbolic link in |
|
mmm... in my case I just reverted the offending commits: JuliaDataCubes/YAXArrays.jl@15a9a0d |
|
regardless, something is off in your PR, because not even the docs are being build correctly, a missing |
what do you mean missing base ? We do have a custom domain, our url link to the document will be: https://qutip.org/QuantumToolbox.jl/ |
|
Why do you think our docs is not rendered correctly ? I can build it locally, and I didn't see any error in CI pipeline ? |
|
Ok |
Checklist
Thank you for contributing to
QuantumToolbox.jl! Please make sure you have finished the following tasks before opening the PR.make test.juliaformatted by running:make format.docs/folder) related to code changes were updated and able to build locally by running:make docs.CHANGELOG.mdshould be updated (regarding to the code changes) and built by running:make changelog.Request for a review after you have completed all the tasks. If you have not finished them all, you can also open a Draft Pull Request to let the others know this on-going work.
Description
I remove all the unnecessary files since
DocumenterVitepress.jlwill copy from the template if we didn't specify them.However, we still need to customize the following files for some reasons (I modify it after I copied from the newest template):
config.mts: to add tutorial, benchmarks links in the navbar; also, some settings for documentation markdownstyle.css: remove the weird extra blur of our logo in home page